/*
 * Remoteproc Framework
 *
 * Copyright(c) 2018 Xilinx Ltd.
 * Copyright(c) 2011 Texas Instruments, Inc.
 * Copyright(c) 2011 Google, Inc.
 * All rights reserved.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

#ifndef REMOTEPROC_H
#define REMOTEPROC_H

#include <metal/io.h>
#include <metal/mutex.h>
#include <metal/compiler.h>

#if defined __cplusplus
extern "C" {
#endif

#define RSC_NOTIFY_ID_ANY 0xFFFFFFFFU

#define RPROC_MAX_NAME_LEN 32

/**
 * struct resource_table - 固件资源表头
 * @ver: 版本号
 * @num: 资源项个数
 * @reserved: 预留(必须为0)
 * @offset: 指向各种资源项的偏移量数组.
 *
 * 资源表本质上是远程remoteproc所需的系统资源列表. 它还可能包括配置项.
 * 如果需要, 远程remoteproc固件应该包含这个专用的资源表作为ELF的.resource_table节.
 *
 * 有些资源项仅仅是通知, 其中主机被告知特定的远程进程配置. 其他资源项要求主机做一些事情
 * (例如分配系统资源). 有时需要协商, 固件请求资源, 一旦分配, 主机应该提供它的详细信息
 * (例如: 分配的内存区域的地址).
 *
 * 这个结构表示的资源表的头包含一个版本号(如果我们将来需要改变这种格式), 可用资源项的数
 * 量以及它们在表中的偏移量.
 *
 * 紧跟着这个资源表头的是资源项本身, 每个资源项都以一个资源项头开始(如下所述).
 */
METAL_PACKED_BEGIN
struct resource_table {
    uint32_t ver;
    uint32_t num;
    uint32_t reserved[2];
    uint32_t offset[0];
} METAL_PACKED_END;

/**
 * struct fw_rsc_hdr - 固件资源项头
 * @type: 资源类型
 * @data: 资源数据
 *
 * 每个资源项都以一个struct fw_rsc_hdr'头开始, 提供它的类型. 资源项本身的内容跟随该头,
 * 并且应该根据资源类型对其进行解析.
 */
METAL_PACKED_BEGIN
struct fw_rsc_hdr {
    uint32_t type;
    uint8_t data[0];
} METAL_PACKED_END;

/**
 * enum fw_resource_type - 资源项类型
 *
 * @RSC_CARVEOUT:     请求分配物理上连续的内存区域.
 * @RSC_DEVMEM:       请求一个被映射到iommu_map的基于内存的外设.
 * @RSC_TRACE:        宣布远程remoteproc将向其中写入日志的跟踪缓冲区的可用性.
 * @RSC_VDEV:         声明对virtio设备的支持, 并作为它的virtio头.
 * @RSC_VENDOR_START: 供应商特定资源类型范围的开始.
 * @RSC_VENDOR_END  : 供应商特定资源类型范围的结束.
 * @RSC_LAST:         把这个放在最后.
 *
 * 有关特定资源类型的更多详细信息, 请参阅下面的专用结构.
 *
 * 请注意, 这些值被用作rproc_handle_rsc查找表的索引, 因此请保持它们相同.
 * 此外, @RSC_LAST用于在访问查找表之前检查索引的有效性, 因此请根据需要更新它.
 */
enum fw_resource_type {
    RSC_CARVEOUT = 0,
    RSC_DEVMEM = 1,
    RSC_TRACE = 2,
    RSC_VDEV = 3,
    RSC_LAST = 4,
    RSC_VENDOR_START = 128,
    RSC_VENDOR_END = 512,
};

#define FW_RSC_U64_ADDR_ANY 0xFFFFFFFFFFFFFFFFUL
#define FW_RSC_U32_ADDR_ANY 0xFFFFFFFFUL

/**
 * struct fw_rsc_carveout - 物理连续内存请求
 * @da: 设备地址
 * @pa: 物理地址
 * @len: 长度(以字节为单位)
 * @flags: IOMMU保护标志
 * @reserved: 预留(必须为0)
 * @name: 请求的内存区域的人类可读的名称.
 *
 * 这个资源项请求主机分配一个物理上连续的内存区域.
 *
 * 这些请求项应该先于其他固件资源项, 因为其他项可能会请求在这些内存区域中放置其他数据
 * 对象(例如数据/代码段, 跟踪资源项等等).
 *
 * Allocating memory this way helps utilizing the reserved physical memory
 * (e.g. CMA) more efficiently, and also minimizes the number of TLB entries
 * needed to map it (in case @rproc is using an IOMMU). Reducing the TLB
 * pressure is important; it may have a substantial impact on performance.
 *
 * If the firmware is compiled with static addresses, then @da should specify
 * the expected device address of this memory region. If @da is set to
 * FW_RSC_ADDR_ANY, then the host will dynamically allocate it, and then
 * overwrite @da with the dynamically allocated address.
 *
 * We will always use @da to negotiate the device addresses, even if it
 * isn't using an iommu. In that case, though, it will obviously contain
 * physical addresses.
 *
 * Some remote remoteprocs needs to know the allocated physical address
 * even if they do use an iommu. This is needed, e.g., if they control
 * hardware accelerators which access the physical memory directly (this
 * is the case with OMAP4 for instance). In that case, the host will
 * overwrite @pa with the dynamically allocated physical address.
 * Generally we don't want to expose physical addresses if we don't have to
 * (remote remoteprocs are generally _not_ trusted), so we might want to
 * change this to happen _only_ when explicitly required by the hardware.
 *
 * @flags is used to provide IOMMU protection flags, and @name should
 * (optionally) contain a human readable name of this carveout region
 * (mainly for debugging purposes).
 */
METAL_PACKED_BEGIN
struct fw_rsc_carveout {
    uint32_t type;
    uint32_t da;
    uint32_t pa;
    uint32_t len;
    uint32_t flags;
    uint32_t reserved;
    uint8_t name[RPROC_MAX_NAME_LEN];
} METAL_PACKED_END;

/**
 * struct fw_rsc_devmem - IOMMU映射请求
 * @da: 设备地址
 * @pa: 物理地址
 * @len: 长度(以字节为单位)
 * @flags: IOMMU保护标志
 * @reserved: 预留(必须为0)
 * @name: 要映射的请求区域的人类可读名称.
 *
 * This resource entry requests the host to iommu map a physically contiguous
 * memory region. This is needed in case the remote remoteproc requires
 * access to certain memory-based peripherals; _never_ use it to access
 * regular memory.
 *
 * This is obviously only needed if the remote remoteproc is accessing memory
 * via an iommu.
 *
 * @da should specify the required device address, @pa should specify
 * the physical address we want to map, @len should specify the size of
 * the mapping and @flags is the IOMMU protection flags. As always, @name may
 * (optionally) contain a human readable name of this mapping (mainly for
 * debugging purposes).
 *
 * Note: at this point we just "trust" those devmem entries to contain valid
 * physical addresses, but this isn't safe and will be changed: eventually we
 * want remoteproc implementations to provide us ranges of physical addresses
 * the firmware is allowed to request, and not allow firmwares to request
 * access to physical addresses that are outside those ranges.
 */
METAL_PACKED_BEGIN
struct fw_rsc_devmem {
    uint32_t type;
    uint32_t da;
    uint32_t pa;
    uint32_t len;
    uint32_t flags;
    uint32_t reserved;
    uint8_t name[RPROC_MAX_NAME_LEN];
} METAL_PACKED_END;

/**
 * struct fw_rsc_trace - 跟踪缓冲区声明.
 * @da: 设备地址
 * @len: 长度(以字节为单位)
 * @reserved: 预留(必须为0)
 * @name: 跟踪缓冲区的人类可读名称.
 *
 * This resource entry provides the host information about a trace buffer
 * into which the remote remoteproc will write log messages.
 *
 * @da specifies the device address of the buffer, @len specifies
 * its size, and @name may contain a human readable name of the trace buffer.
 *
 * After booting the remote remoteproc, the trace buffers are exposed to the
 * user via debugfs entries (called trace0, trace1, etc..).
 */
METAL_PACKED_BEGIN
struct fw_rsc_trace {
    uint32_t type;
    uint32_t da;
    uint32_t len;
    uint32_t reserved;
    uint8_t name[RPROC_MAX_NAME_LEN];
} METAL_PACKED_END;

/**
 * struct fw_rsc_vdev_vring - vring描述符条目
 * @da:       设备地址
 * @align:    vring的消费者部分和生产者部分之间的对齐.
 * @num:      此vring支持的缓冲区数目(必须是2的幂).
 * @notifyid: vring的唯一rproc范围的通知索引.
 *            这个通知索引在启动远程remoteproc时使用, 让它知道这个线程被触发了.
 * @reserved: 预留(必须为0)
 *
 * This descriptor is not a resource entry by itself; it is part of the
 * vdev resource type (see below).
 *
 * Note that @da should either contain the device address where
 * the remote remoteproc is expecting the vring, or indicate that
 * dynamically allocation of the vring's device address is supported.
 */
METAL_PACKED_BEGIN
struct fw_rsc_vdev_vring {
    uint32_t da;
    uint32_t align;
    uint32_t num;
    uint32_t notifyid;
    uint32_t reserved;
} METAL_PACKED_END;

/**
 * struct fw_rsc_vdev - virtio设备头
 * @id: virtio设备ID (如virtio_ids.h)
 * @notifyid: vdev的唯一的rproc范围通知索引.
 *            这个通知索引在启动远程remoteproc时使用, 让它知道这个vdev的状态/特性发生了变化.
 * @dfeatures specifies the virtio device features supported by the firmware
 * @gfeatures is a place holder used by the host to write back the
 * negotiated features that are supported by both sides.
 * @config_len is the size of the virtio config space of this vdev. The config
 * space lies in the resource table immediate after this vdev header.
 * @status is a place holder where the host will indicate its virtio progress.
 * @num_of_vrings indicates how many vrings are described in this vdev header
 * @reserved: reserved (must be zero)
 * @vring is an array of @num_of_vrings entries of 'struct fw_rsc_vdev_vring'.
 *
 * This resource is a virtio device header: it provides information about
 * the vdev, and is then used by the host and its peer remote remoteprocs
 * to negotiate and share certain virtio properties.
 *
 * By providing this resource entry, the firmware essentially asks remoteproc
 * to statically allocate a vdev upon registration of the rproc (dynamic vdev
 * allocation is not yet supported).
 *
 * Note: unlike virtualization systems, the term 'host' here means
 * the Linux side which is running remoteproc to control the remote
 * remoteprocs. We use the name 'gfeatures' to comply with virtio's terms,
 * though there isn't really any virtualized guest OS here: it's the host
 * which is responsible for negotiating the final features.
 * Yeah, it's a bit confusing.
 *
 * Note: immediately following this structure is the virtio config space for
 * this vdev (which is specific to the vdev; for more info, read the virtio
 * spec). the size of the config space is specified by @config_len.
 */
METAL_PACKED_BEGIN
struct fw_rsc_vdev {
    uint32_t type;
    uint32_t id;
    uint32_t notifyid;
    uint32_t dfeatures;
    uint32_t gfeatures;
    uint32_t config_len;
    uint8_t status;
    uint8_t num_of_vrings;
    uint8_t reserved[2];
    struct fw_rsc_vdev_vring vring[0];
} METAL_PACKED_END;

/**
 * struct fw_rsc_vendor - 远程处理器供应商特定的资源
 * @type: 资源类型
 * @len:  资源长度
 *
 * 这个资源项告诉主机远程所需的特定于供应商的资源.
 * 这些请求项应该在其他共享资源项(如vdev, vring)之前.
 */
METAL_PACKED_BEGIN
struct fw_rsc_vendor {
    uint32_t type;
    uint32_t len;
} METAL_PACKED_END;

struct loader_ops;
struct image_store_ops;
struct remoteproc_ops;

/**
 * 这个结构表示Remoteproc使用的内存.
 * @da:   设备内存地址
 * @pa:   物理内存地址
 * @size: 内存大小
 * @io:   指向I/O区域的指针
 * @node: 列表节点
 */
struct remoteproc_mem {
    metal_phys_addr_t da;
    metal_phys_addr_t pa;
    size_t size;
    char name[RPROC_MAX_NAME_LEN];
    struct metal_io_region *io;
    struct metal_list node;
};

/**
 * 该结构由remoteproc维护, 表示远程处理器实例. 该结构用作使用remoteproc API的主要参数.
 * @bootaddr:  固件入口地址.
 * @loader:    可执行镜像加载程序操作接口.
 * @lock:      互斥锁.
 * @ops:       远程处理器操作接口.
 * @rsc_table: 指向远程处理器资源表的接口.
 * @rsc_len:   远程处理器资源表的长度.
 * @rsc_io:    资源表的I/O内存区域.
 * @mems:      远程处理器内存列表.
 * @vdevs:     远程处理器virtio设备列表.
 * @bitmap:    远程处理器子设备的通知ID的位图.
 * @state:     远程处理器状态.
 * @priv:      私有数据.
 */
struct remoteproc {
    metal_mutex_t lock;
    void *rsc_table;
    size_t rsc_len;
    struct metal_io_region *rsc_io;
    struct metal_list mems;
    struct metal_list vdevs;
    unsigned long bitmap;
    const struct remoteproc_ops *ops; /* 远程处理器操作接口 */
    metal_phys_addr_t bootaddr;       /* 固件入口地址 */
    const struct loader_ops *loader;  /* 可执行镜像加载程序操作接口 */
    unsigned int state;
    void *priv;
};

/**
 * struct remoteproc_ops
 *
 * remoteproc operations needs to be implemented by each remoteproc driver
 *
 * @init: initialize the remoteproc instance
 * @remove: remove the remoteproc instance
 * @mmap: memory mapped the memory with physical address or destination
 *        address as input.
 * @handle_rsc: handle the vendor specific resource
 * @config: configure the remoteproc to make it ready to load and run
 *          executable
 * @start: kick the remoteproc to run application
 * @stop: stop the remoteproc from running application, the resource such as
 *        memory may not be off.
 * @shutdown: shutdown the remoteproc and release its resources.
 * @notify: notify the remote
 * @get_mem: get remoteproc memory I/O region.
 */
struct remoteproc_ops {
    struct remoteproc *(*init)(struct remoteproc *rproc,
        const struct remoteproc_ops *ops, void *arg);
    void (*remove)(struct remoteproc *rproc);
    void *(*mmap)(struct remoteproc *rproc,
        metal_phys_addr_t *pa, metal_phys_addr_t *da,
        size_t size, unsigned int attribute, struct metal_io_region **io);
    int (*handle_rsc)(struct remoteproc *rproc, void *rsc, size_t len);
    int (*config)(struct remoteproc *rproc, void *data);
    int (*start)(struct remoteproc *rproc);
    int (*stop)(struct remoteproc *rproc);
    int (*shutdown)(struct remoteproc *rproc);
    int (*notify)(struct remoteproc *rproc, uint32_t id);
    /**
     * get_mem
     *
     * get remoteproc memory I/O region by either name, virtual
     * address, physical address or device address.
     *
     * @rproc - pointer to remoteproc instance
     * @name - memory name
     * @pa - physical address
     * @da - device address
     * @va - virtual address
     * @size - memory size
     * @buf - pointer to remoteproc_mem struct object to store result
     *
     * @returns remoteproc memory pointed by buf if success, otherwise NULL
     */
    struct remoteproc_mem *(*get_mem)(struct remoteproc *rproc, const char *name,
        metal_phys_addr_t pa, metal_phys_addr_t da, void *va, size_t size,
        struct remoteproc_mem *buf);
};

/* Remoteproc error codes */
#define RPROC_EBASE                   0
#define RPROC_ENOMEM                  (RPROC_EBASE + 1)
#define RPROC_EINVAL                  (RPROC_EBASE + 2)
#define RPROC_ENODEV                  (RPROC_EBASE + 3)
#define RPROC_EAGAIN                  (RPROC_EBASE + 4)
#define RPROC_ERR_RSC_TAB_TRUNC       (RPROC_EBASE + 5)
#define RPROC_ERR_RSC_TAB_VER         (RPROC_EBASE + 6)
#define RPROC_ERR_RSC_TAB_RSVD        (RPROC_EBASE + 7)
#define RPROC_ERR_RSC_TAB_VDEV_NRINGS (RPROC_EBASE + 9)
#define RPROC_ERR_RSC_TAB_NP          (RPROC_EBASE + 10)
#define RPROC_ERR_RSC_TAB_NS          (RPROC_EBASE + 11)
#define RPROC_ERR_LOADER_STATE        (RPROC_EBASE + 12)
#define RPROC_EMAX                    (RPROC_EBASE + 16)
#define RPROC_EPTR                    (void *)(-1)
#define RPROC_EOF                     (void *)(-1)

static inline long RPROC_PTR_ERR(const void *ptr)
{
    return (long)ptr;
}

static inline int RPROC_IS_ERR(const void *ptr)
{
    if ((unsigned long)ptr >= (unsigned long)(-RPROC_EMAX))
        return 1;
    else
        return 0;
}

static inline void *RPROC_ERR_PTR(long error)
{
    return (void *)error;
}

/**
 * enum rproc_state - 远程处理器状态
 * @RPROC_OFFLINE:    remote is offline
 * @RPROC_CONFIGURED: remote is configured
 * @RPROC_READY:      remote is ready to start
 * @RPROC_RUNNING:    remote is up and running
 * @RPROC_SUSPENDED:  remote is suspended
 * @RPROC_ERROR:      remote has error; need to recover
 * @RPROC_STOPPED:    remote is stopped
 * @RPROC_LAST:       just keep this one at the end
 */
enum remoteproc_state {
    RPROC_OFFLINE    = 0,
    RPROC_CONFIGURED = 1,
    RPROC_READY      = 2,
    RPROC_RUNNING    = 3,
    RPROC_SUSPENDED  = 4,
    RPROC_ERROR      = 5,
    RPROC_STOPPED    = 6,
    RPROC_LAST       = 7,
};

/**
 * @brief Initializes remoteproc resource.
 *
 * @param rproc Pointer to remoteproc instance
 * @param ops   Pointer to remoteproc operations
 * @param priv  Pointer to private data
 *
 * @return Created remoteproc pointer
 */
struct remoteproc *remoteproc_init(struct remoteproc *rproc,
    const struct remoteproc_ops *ops, void *priv);

/**
 * @brief Remove remoteproc resource
 *
 * @param rproc Pointer to remoteproc instance
 *
 * @return 0 for success, negative value for failure
 */
int remoteproc_remove(struct remoteproc *rproc);

/**
 * @brief Initialize remoteproc memory
 *
 * @param mem   Pointer to remoteproc memory
 * @param name  Memory name
 * @param pa    Physical address
 * @param da    Device address
 * @param size  Memory size
 * @param io    Pointer to the I/O region
 */
static inline void
remoteproc_init_mem(struct remoteproc_mem *mem, const char *name,
    metal_phys_addr_t pa, metal_phys_addr_t da, size_t size,
    struct metal_io_region *io)
{
    if (!mem || !io || size == 0) {
        return;
    }
    if (name) {
        strncpy(mem->name, name, sizeof(mem->name));
    } else {
        mem->name[0] = 0;
    }
    mem->pa = pa;
    mem->da = da;
    mem->io = io;
    mem->size = size;
}

/**
 * @brief Add remoteproc memory
 *
 * @param rproc Pointer to remoteproc
 * @param mem   Pointer to remoteproc memory
 */
static inline void
remoteproc_add_mem(struct remoteproc *rproc, struct remoteproc_mem *mem)
{
    if (!rproc || !mem) {
        return;
    }

    metal_list_add_tail(&rproc->mems, &mem->node);
}

/**
 * @brief Get remoteproc memory I/O region with name
 *
 * @param rproc Pointer to the remote processor
 * @param name  Name of the shared memory
 *
 * @return Metal I/O region pointer, NULL for failure
 */
struct metal_io_region * remoteproc_get_io_with_name(struct remoteproc *rproc, const char *name);

/**
 * @brief Get remoteproc memory I/O region with physical address
 *
 * @param rproc Pointer to the remote processor
 * @param pa    Physical address
 *
 * @return Metal I/O region pointer, NULL for failure
 */
struct metal_io_region * remoteproc_get_io_with_pa(struct remoteproc *rproc, metal_phys_addr_t pa);

/**
 * @brief Get remoteproc memory I/O region with device address
 *
 * @param rproc  Pointer to the remote processor
 * @param da     Device address
 * @param offset I/O region offset of the device address
 *
 * @return Metal I/O region pointer, NULL for failure
 */
struct metal_io_region * remoteproc_get_io_with_da(struct remoteproc *rproc, metal_phys_addr_t da, unsigned long *offset);

/**
 * @brief Get remoteproc memory I/O region with virtual address
 *
 * @param rproc Pointer to the remote processor
 * @param va    Virtual address
 *
 * @return Metal I/O region pointer, NULL for failure
 */
struct metal_io_region * remoteproc_get_io_with_va(struct remoteproc *rproc, void *va);

/**
 * @brief Remoteproc mmap memory
 *
 * @param rproc     Pointer to the remote processor
 * @param pa        Physical address pointer
 * @param da        Device address pointer
 * @param size      Size of the memory
 * @param attribute Memory attribute
 * @param io        Pointer to the I/O region
 *
 * @return Pointer to the memory
 */
void *remoteproc_mmap(struct remoteproc *rproc, metal_phys_addr_t *pa,
    metal_phys_addr_t *da, size_t size, unsigned int attribute, struct metal_io_region **io);

/**
 * @brief Parse and set resource table of remoteproc
 *
 * @param rproc     Pointer to remoteproc instance
 * @param rsc_table Pointer to resource table
 * @param rsc_size  Resource table size
 *
 * @return 0 for success and negative value for errors
 */
int remoteproc_set_rsc_table(struct remoteproc *rproc, struct resource_table *rsc_table, size_t rsc_size);

/**
 * @brief This function configures the remote processor to get it
 * ready to load and run executable.
 *
 * @param rproc Pointer to remoteproc instance to start
 * @param data  Configuration data
 *
 * @return 0 for success and negative value for errors
 */
int remoteproc_config(struct remoteproc *rproc, void *data);

/**
 * @brief This function starts the remote processor.
 * It assumes the firmware is already loaded.
 *
 * @param rproc Pointer to remoteproc instance to start
 *
 * @return 0 for success and negative value for errors
 */
int remoteproc_start(struct remoteproc *rproc);

/**
 * @brief This function stops the remote processor but it
 * will not release its resource.
 *
 * @param rproc Pointer to remoteproc instance
 *
 * @return 0 for success and negative value for errors
 */
int remoteproc_stop(struct remoteproc *rproc);

/**
 * @brief This function shuts down the remote processor and
 * releases its resources.
 *
 * @param rproc Pointer to remoteproc instance
 *
 * @return 0 for success and negative value for errors
 */
int remoteproc_shutdown(struct remoteproc *rproc);

/**
 * @brief Loads the executable
 *
 * Expects the user application defines how to open the executable file and how
 * to get data from the executable file and how to load data to the target
 * memory.
 *
 * @param rproc     Pointer to the remoteproc instance
 * @param path      Optional path to the image file
 * @param store     Pointer to user defined image store argument
 * @param store_ops Pointer to image store operations
 * @param img_info  Pointer to memory which stores image information used by remoteproc loader
 *
 * @return 0 for success and negative value for failure
 */
int remoteproc_load(struct remoteproc *rproc, const char *path,
    void *store, const struct image_store_ops *store_ops, void **img_info);

/**
 * @brief Loads the executable
 *
 * Expects the caller has loaded image data to local
 * memory and passed to the this function. If the function needs more
 * image data it will return the next expected image data offset and
 * the next expected image data length. If the function requires the
 * caller to download image data to the target memory, it will also
 * return the target physical address besides the offset and length.
 * This function can be used to load firmware in stream mode. In this
 * mode, you cannot do seek to the executable file. If the executable
 * is ELF, it cannot get the resource table section before it loads
 * the full ELF file. Furthermore, application usually don't store
 * the data which is loaded to local memory in streaming mode, and
 * thus, in this mode, it will load the binary to the target memory
 * before it gets the resource table. And thus, when calling this function
 * don't put the target executable memory in the resource table, as
 * this function will parse the resource table after it loads the binary
 * to target memory.
 *
 * @param rproc     Pointer to the remoteproc instance
 * @param img_data  Pointer to image data for remoteproc loader to parse
 * @param offset    Image data offset to the beginning of the image file
 * @param len       Image data length
 * @param img_info  Pointer to memory which stores image information used
 *                  by remoteproc loader
 * @param pa        Pointer to the target memory physical address. If the next
 *                  expected data doesn't need to load to the target memory,
 *                  the function will set it to ANY.
 * @param io        Pointer to the io region. If the next expected data
 *                  doesn't need to load to the target memory, the function
 *                  will set it to NULL.
 * @param noffset   Pointer to the next image data offset to the beginning
 *                  of the image file needs to load to local or to the
 *                  target memory.
 * @param nlen      Pointer to the next image data length needs to load to
 *                  local or to the target memory.
 * @param nmlen     Pointer to the memory size. It is only used when the
 *                  next expected data is going to be loaded to the target
 *                  memory. E.g. in ELF, it is possible that loadable
 *                  segment in memory is larger that the segment data in
 *                  the ELF file. In this case, application will need to
 *                  pad the rest of the memory with padding.
 * @param padding   Pointer to the padding value. It is only used when the
 *                  next expected data is going to be loaded to the target
 *                  memory and the target memory size is larger than the
 *                  segment data in the executable file.
 *
 * @return 0 for success and negative value for failure
 */
int remoteproc_load_noblock(struct remoteproc *rproc, const void *img_data,
    size_t offset, size_t len, void **img_info,
    metal_phys_addr_t *pa,  struct metal_io_region **io,
    size_t *noffset, size_t *nlen, size_t *nmlen, unsigned char *padding);

/**
 * @brief Allocate notifyid for resource
 *
 * @param rproc Pointer to the remoteproc instance
 * @param start Start of the id range
 * @param end   End of the id range
 *
 * @return Allocated notify id
 */
unsigned int remoteproc_allocate_id(struct remoteproc *rproc,
    unsigned int start, unsigned int end);

/**
 * @brief Create virtio device, it returns pointer to the created virtio device.
 *
 * @param rproc   Pointer to the remoteproc instance
 * @param vdev_id virtio device ID
 * @param role    virtio device role
 * @param rst_cb  virtio device reset callback
 *
 * @return Pointer to the created virtio device, NULL for failure.
 */
struct virtio_device * remoteproc_create_virtio(struct remoteproc *rproc,
    int vdev_id, unsigned int role, void (*rst_cb)(struct virtio_device *vdev));

/**
 * @brief Remove virtio device
 *
 * @param rproc Pointer to the remoteproc instance
 * @param vdev  Pointer to the virtio device
 */
void remoteproc_remove_virtio(struct remoteproc *rproc, struct virtio_device *vdev);

/**
 * @brief      Remoteproc收到通知后, 将检查其子设备是否收到通知.
 * @param[in]  rproc    指向Remoteproc实例的指针.
 * @param[in]  notifyid 通知id.
 * @return     成功返回0, 失败返回错误码(负数).
 */
int remoteproc_get_notification(struct remoteproc *rproc, uint32_t notifyid);

#if defined __cplusplus
}
#endif

#endif /* REMOTEPROC_H_ */
